/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.runtime.scheduler.loading;

import org.apache.flink.annotation.Internal;

import java.io.Serializable;

/** The class is used to represent the loading weight abstraction. */
@Internal
public interface LoadingWeight extends Comparable<LoadingWeight>, Serializable {

    /**
     * Get the loading value.
     *
     * @return A float represented the loading.
     */
    float getLoading();

    /**
     * Merge the other loading weight and this one into a new object.
     *
     * @param other A loading weight object.
     * @return The new merged {@link LoadingWeight}.
     */
    LoadingWeight merge(LoadingWeight other);
}
